Standard XML attachment

The standard attachment is an aggregate of all the other common function-specific attachment types. It should be used for all new XML scripting requirements. XML scripts written to use the standard XML attachment will typically be much clearer to read and understand.

Any XML scripts written to use the previous, function-specific attachment types will continue to work as normal.

Schema

<mkzAttachment type="standard">
	<onPreview>
		<adjust property="text">{value}</adjust>
	</onPreview>

	<onPreSubmit>
		<checkPageSizes failAction="block|reject|resize" />
		<setAddress metadata="true|false" box="X,Y,W,H" options="nn" />
		<checkValidAddress minimumLines="nn" accuracy="strict|postcode|none" failAction="block|reject|none" />
		<checkOtherAddress startPage="nn" failAction="block|reject|none" [box="X,Y,W,H"] />
		<discardLetter/>

		<xmlPath>{folder-where-XML-files-are-stored}</xmlPath>
		<appendXml>{XML-filename}</appendXml>

		<stampText [scan|identifier="text"] pages="page-specifier" format="format-specifier" >{text}</stampText> 
		<stampRect pages="page-specifier" format="format-specifier" /> 
		<stampImage [scan|identifier="filename"] pages="page-specifier" format="format-specifier" >{filename}</stampImage> 
		<stampBarcode [scan|identifier="code"] pages="page-specifier" format="format-specifier" >{code}</stampBarcode>
		<stampDataMatrix [scan|identifier="code"] pages="page-specifier" format="format-specifier" >{code}</stampDataMatrix>

		<dataQuery>
			<sqlConnection>{connection-string}</sqlConnection>
			<sqlParameter identifier="name" [direction="out"] [type="int"] >param-name</sqlParameter>
			<sqlColumn identifier="name" [type="int"] >column-name</sqlColumn>
			<sqlExecuteQuery>{stored-procedure-name}</sqlExecuteQuery>

			<csvFilename>{CSV-file-full-path-name}</csvFilename>
			<csvColumn identifier="name" >column-name-or-index</csvColumn>
			<csvExecuteQuery csvColumn="name-or-index" equals="{text}" | contains="{text}" />
		</dataQuery>
	</onPreSubmit>
	
	<onSubmit>
		<letterClass>{first|second}</letterClass> 
		<letterChroma>{colour|mono}</letterChroma> 
		<letterPlex>{simplex|duplex}</letterPlex> 
		<letterUser>user-ID</letterUser> 
		<letterOutput>{output-ID}</letterOutput> 
		<letterStatus>{status-name}
			[<rejectionCode>{code}</rejectionCode>]
		</letterStatus>
		<letterDelivery>{postal|electronic}</letterDelivery> 
		<letterName [scan|identifier] >{letter-name}</letterName>
		<letterStream [scan|identifier] >{stream-name}</letterStream>
		
		<pdfPath>{folder-where-PDF-files-are-stored}</pdfPath>
		<appendPdf [identifier="PDF-filename"] 
				   [mergeWithLetter="true|false" | useAsBackground="true|false" | insertRef="{true|false}"] 
				   [colour="true|false"] [first="true|false"] [map="true|false"] >{PDF-filename}</appendPdf>
		<mergePdf [identifier="PDF-filename"] position="nn" >{PDF-filename}</mergePdf>
		<insertPages position="nn" pages="mm" />
		<deletePages position="nn" pages="mm" />

		<customData [scan|identifier]  [dateFormat="yyyyMMdd"] 
					[property="prop-name"] [metadata="meta-name"]
					field="ff" | multiField="ff,gg,hh..."  [parse="split-chars"] >{default-text}
		</customData>

		<stampText [scan|identifier="text"] pages="page-specifier" format="format-specifier" >{text}</stampText> 
		<stampRect pages="page-specifier" format="format-specifier" /> 
		<stampImage [scan|identifier="filename"] pages="page-specifier" format="format-specifier" >{filename}</stampImage> 
		<stampBarcode [scan|identifier="code"] pages="page-specifier" format="format-specifier" >{code}</stampBarcode>
		<stampDataMatrix [scan|identifier="code"] pages="page-specifier" format="format-specifier" >{code}</stampDataMatrix>

		<emailSubject [scan|identifier] >{subj}</emailSubject>
		<emailTo [scan|identifier] >{recipient}</emailTo>
		<emailFrom [scan|identifier] >{sender}</emailFrom>
		<emailCc [scan|identifier] >{recipient}</emailCc>
		<emailBody [scan|identifier] >{text}</emailBody>
		<emailBodyFolder [scan|identifier] >{pathname}</emailBodyFolder>
		<emailBodyFile [scan|identifier] >{filename}</emailBodyFile>
		<emailAttachmentName [scan|identifier] >{name}</emailAttachmentName>
		<emailReplyTo [scan|identifier] >{recipient}</emailReplyTo>
		<smsTo [scan|identifier] provider="name" >{recipient}</smsTo>
		<smsFrom [scan|identifier] >{sender}</smsFrom>
		<smsBody [scan|identifier] >{text}</smsBody>
		<smsBodyFile [scan|identifier] >{filename}</smsBodyFile>
		<msgDelivery>{method}</msgDelivery>
		<msgPassword>{passcode}</msgPassword>
		<msgSubstitute [scan|identifier] subKey="@name@" >{substitution-text}</msgSubstitute>
		<useNHSSecureEmail/>
		<checkRequiredValues/>

		<reselectOutput/>

		<combineLetter>
			<combineAddress/> | <combineRecipient/>
			<combinePostcode/> 
			<combineSSC/>
			<combineDPS/>
			<combineField [scan|identifier] >{default-text}</combineField>
			<topmost />
		</combineLetter>

		<carbonCopy>
			<ccAddresses identifier="identifier-name"  [accuracy="all|any"] >{default}</ccAddresses>
			<ccSingleAddress identifier="identifier-name"  [accuracy="all|any"] >{default}</ccSingleAddress>
			<coverLetterFolder>{path-to-cover-letters}</coverLetterFolder> 
			<coverLetter>{cover-letter-filename}</coverLetter> 
			<stripAttachments [stripSupplements="true|false"] />boolean</stripAttachments>
			<ccTemplate>{template-ID}</ccTemplate>
		</carbonCopy>

		<dataQuery>
			<sqlConnection>{connection-string}</sqlConnection>
			<sqlParameter identifier="name" [direction="out"] [type="int"] >param-name</sqlParameter>
			<sqlColumn identifier="name" [type="int"] >column-name</sqlColumn>
			<sqlExecuteQuery>{stored-procedure-name}</sqlExecuteQuery>

			<csvFilename>{CSV-file-full-path-name}</csvFilename>
			<csvColumn identifier="name" [type="int"]>column-name-or-index</csvColumn>
			<csvExecuteQuery csvColumn="name-or-index" equals="{text}" | contains="{text}" />
		</dataQuery>
	</onSubmit>

	<onRelease>
		<loadCustomData/>
		<makePdfFileCopy folderName="name" fileName="name" includeUnique="random|time|timeMs" />

		<sendEmail attachLetter="true" />
		<sendSms/>
	</onRelease>

	<onRelay>
		<stampText [scan|identifier="text"] pages="page-specifier" format="format-specifier" >{text}</stampText> 
		<stampRect pages="page-specifier" format="format-specifier" /> 
		<stampImage [scan|identifier="filename"] pages="page-specifier" format="format-specifier" >{filename}</stampImage> 
		<stampBarcode [scan|identifier="code"] pages="page-specifier" format="format-specifier" >{code}</stampBarcode>
		<stampDataMatrix [scan|identifier="code"] pages="page-specifier" format="format-specifier" >{code}</stampDataMatrix>
	</onRelay>


</mkzAttachment>					

The XML can be executed during any phase. N.B. The OnPreview phase is only relevant to the QuickPost page (PostBox client)

The XML supports the following elements during OnPreSubmit. There can be only one instance of each of these

The XML supports the following elements during OnSubmit. There can be multiple instances of any of these.

<letterClass> Set the letter postage class.

<letterChroma> Set the letter chroma (colour intensity).

<letterPlex> Set the letter plex. (double/single sided)

<letterUser> Set the letter user (the user who submitted the letter).

<letterOutput> Set the letter output.

<letterStatus> Set the status.

<letterDelivery> Set the delivery method.

<reselectOutput>true</reselectOutput>

<appointmentDate changeClassDays="minval,maxval" dontSendDays="rejectval" > <appointmentDate>

Examples

<appointmentDate" scan="20,40,150,180" date="future" changeClassDays="4,10" dontSendDays="3" >